fix(sdk-logs): ensure default resource attributes are used as fallbacks when a resource is passed to LoggerProvider #4564
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ks when a resource is passed to LoggerProvider Before this Resource.default() attributes would only be used if *no* resource was given to LoggerProvider. That would mean that 'service.name' and others could be missing, e.g. when called from NodeSDK.
small reproSave this to "foo.js": const { SeverityNumber } = require('@opentelemetry/api-logs');
const { LoggerProvider, SimpleLogRecordProcessor } = require('@opentelemetry/sdk-logs');
const { ExportResultCode } = require('@opentelemetry/core');
const { Resource } = require('@opentelemetry/resources');
class InspectLogRecordExporter {
export(logs, resultCallback) {
console.dir(logs, { depth: 5 });
resultCallback({ code: ExportResultCode.SUCCESS });
}
shutdown() {
return Promise.resolve();
}
}
const loggerProvider = new LoggerProvider({
resource: new Resource({ foo: 'bar' }),
});
loggerProvider.addLogRecordProcessor(
new SimpleLogRecordProcessor(new InspectLogRecordExporter())
);
const logger = loggerProvider.getLogger('default');
logger.emit({
severityNumber: SeverityNumber.INFO,
severityText: 'INFO',
body: 'this is a log record body',
attributes: { anAttr: 'aValue' },
});And run it without this fix: That shows that the created LogRecord is missing the attributes from |
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #4564 +/- ##
==========================================
+ Coverage 92.83% 92.84% +0.01%
==========================================
Files 328 328
Lines 9486 9487 +1
Branches 2035 2035
==========================================
+ Hits 8806 8808 +2
+ Misses 680 679 -1
|
Zirak
pushed a commit
to Zirak/opentelemetry-js
that referenced
this pull request
Sep 14, 2024
…ks when a resource is passed to LoggerProvider (open-telemetry#4564) Before this Resource.default() attributes would only be used if *no* resource was given to LoggerProvider. That would mean that 'service.name' and others could be missing, e.g. when called from NodeSDK. Co-authored-by: Marc Pichler <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Before this, Resource.default() attributes would only be used if no
resource was given to LoggerProvider. That would mean that
'service.name' and others could be missing, e.g. when called from
NodeSDK.
Here is where, for example, NodeSDK passes in a resource to LoggerProvider:
opentelemetry-js/experimental/packages/opentelemetry-sdk-node/src/sdk.ts
Lines 360 to 362 in aabd1a9